package com.wy.test.protocol.cas.endpoint.ticket;

import java.io.Serializable;

import com.fasterxml.jackson.annotation.JsonTypeInfo;

/**
 * Strategy that determines if the ticket is expired. Implementations of the
 * Expiration Policy define their own rules on what they consider an expired
 * Ticket to be.
 *
 * @author Scott Battaglia
 * @see Ticket
 * @since 3.0.0
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
public interface ExpirationPolicy extends Serializable {

	/**
	 * Method to determine if a Ticket has expired or not, based on the policy.
	 *
	 * @param ticketState The snapshot of the current ticket state
	 * @return true if the ticket is expired, false otherwise.
	 */
	boolean isExpired(TicketState ticketState);

	/**
	 * Method to determine the actual TTL of a ticket, based on the policy.
	 *
	 * @param ticketState The snapshot of the current ticket state
	 * @return The time to live in seconds. A zero value indicates the time duration
	 *         is not supported or is inactive.
	 */
	default Long getTimeToLive(final TicketState ticketState) {
		return getTimeToLive();
	}

	/**
	 * Describes the time duration where this policy should consider the item alive.
	 * Once this time passes, the item is considered expired and dead.
	 *
	 * @return time to live in seconds. A zero value indicates the time duration is
	 *         not supported or is inactive.
	 */
	Long getTimeToLive();

	/**
	 * Describes the idle time duration for the item.
	 *
	 * @return idle time in seconds. A zero value indicates the time duration is not
	 *         supported or is inactive. Unit of measure is defined by the
	 *         implementation.
	 */
	Long getTimeToIdle();

	/**
	 * Gets name of this expiration policy.
	 *
	 * @return the name
	 */
	String getName();
}
